@satorijs/adapter-lark 3.10.6 → 3.11.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/content.d.ts +211 -93
- package/lib/index.cjs +2954 -2474
- package/lib/internal.d.ts +4 -4
- package/lib/message.d.ts +2 -3
- package/lib/types/acs.d.ts +212 -172
- package/lib/types/admin.d.ts +331 -291
- package/lib/types/aily.d.ts +331 -216
- package/lib/types/apaas.d.ts +646 -494
- package/lib/types/application.d.ts +559 -458
- package/lib/types/approval.d.ts +826 -791
- package/lib/types/attendance.d.ts +1094 -994
- package/lib/types/auth.d.ts +66 -61
- package/lib/types/authen.d.ts +221 -186
- package/lib/types/baike.d.ts +258 -233
- package/lib/types/base.d.ts +74 -0
- package/lib/types/bitable.d.ts +830 -770
- package/lib/types/board.d.ts +29 -14
- package/lib/types/calendar.d.ts +660 -605
- package/lib/types/cardkit.d.ts +149 -134
- package/lib/types/compensation.d.ts +84 -49
- package/lib/types/contact.d.ts +1279 -1204
- package/lib/types/corehr.d.ts +4982 -4526
- package/lib/types/directory.d.ts +447 -0
- package/lib/types/docs.d.ts +28 -18
- package/lib/types/document_ai.d.ts +347 -252
- package/lib/types/docx.d.ts +428 -383
- package/lib/types/drive.d.ts +1093 -1048
- package/lib/types/ehr.d.ts +66 -51
- package/lib/types/event.d.ts +16 -6
- package/lib/types/helpdesk.d.ts +816 -741
- package/lib/types/hire.d.ts +3955 -3589
- package/lib/types/human_authentication.d.ts +32 -22
- package/lib/types/im.d.ts +1420 -1295
- package/lib/types/index.d.ts +1422 -330
- package/lib/types/lingo.d.ts +279 -249
- package/lib/types/mail.d.ts +1032 -675
- package/lib/types/mdm.d.ts +105 -37
- package/lib/types/minutes.d.ts +73 -26
- package/lib/types/moments.d.ts +23 -13
- package/lib/types/okr.d.ts +266 -225
- package/lib/types/optical_char_recognition.d.ts +22 -12
- package/lib/types/passport.d.ts +58 -48
- package/lib/types/payroll.d.ts +210 -53
- package/lib/types/performance.d.ts +463 -414
- package/lib/types/personal_settings.d.ts +93 -82
- package/lib/types/report.d.ts +79 -58
- package/lib/types/search.d.ts +265 -235
- package/lib/types/security_and_compliance.d.ts +30 -19
- package/lib/types/sheets.d.ts +356 -321
- package/lib/types/speech_to_text.d.ts +44 -34
- package/lib/types/task.d.ts +998 -1087
- package/lib/types/tenant.d.ts +25 -15
- package/lib/types/translation.d.ts +42 -32
- package/lib/types/trust_party.d.ts +81 -0
- package/lib/types/vc.d.ts +1218 -1123
- package/lib/types/verification.d.ts +11 -6
- package/lib/types/wiki.d.ts +270 -235
- package/lib/types/workplace.d.ts +58 -38
- package/lib/utils.d.ts +2 -2
- package/package.json +4 -4
- package/src/bot.ts +15 -15
- package/src/content.ts +230 -107
- package/src/internal.ts +29 -12
- package/src/message.ts +82 -111
- package/src/types/acs.ts +234 -186
- package/src/types/admin.ts +353 -305
- package/src/types/aily.ts +375 -233
- package/src/types/apaas.ts +754 -568
- package/src/types/application.ts +633 -507
- package/src/types/approval.ts +914 -872
- package/src/types/attendance.ts +1226 -1104
- package/src/types/auth.ts +72 -66
- package/src/types/authen.ts +233 -191
- package/src/types/baike.ts +276 -246
- package/src/types/base.ts +93 -0
- package/src/types/bitable.ts +966 -894
- package/src/types/board.ts +34 -16
- package/src/types/calendar.ts +751 -685
- package/src/types/cardkit.ts +164 -146
- package/src/types/compensation.ts +97 -55
- package/src/types/contact.ts +1465 -1375
- package/src/types/corehr.ts +5664 -5077
- package/src/types/directory.ts +569 -0
- package/src/types/docs.ts +31 -19
- package/src/types/document_ai.ts +401 -287
- package/src/types/docx.ts +492 -438
- package/src/types/drive.ts +1266 -1213
- package/src/types/ehr.ts +71 -53
- package/src/types/event.ts +19 -7
- package/src/types/helpdesk.ts +930 -840
- package/src/types/hire.ts +4453 -4019
- package/src/types/human_authentication.ts +35 -23
- package/src/types/im.ts +1626 -1476
- package/src/types/index.ts +1532 -346
- package/src/types/lingo.ts +299 -263
- package/src/types/mail.ts +1231 -779
- package/src/types/mdm.ts +122 -39
- package/src/types/minutes.ts +88 -28
- package/src/types/moments.ts +26 -14
- package/src/types/okr.ts +286 -238
- package/src/types/optical_char_recognition.ts +25 -13
- package/src/types/passport.ts +62 -50
- package/src/types/payroll.ts +254 -57
- package/src/types/performance.ts +528 -467
- package/src/types/personal_settings.ts +101 -89
- package/src/types/report.ts +86 -62
- package/src/types/search.ts +285 -249
- package/src/types/security_and_compliance.ts +33 -21
- package/src/types/sheets.ts +421 -379
- package/src/types/speech_to_text.ts +48 -36
- package/src/types/task.ts +1152 -1260
- package/src/types/tenant.ts +29 -17
- package/src/types/translation.ts +46 -34
- package/src/types/trust_party.ts +110 -0
- package/src/types/vc.ts +1397 -1283
- package/src/types/verification.ts +13 -7
- package/src/types/wiki.ts +293 -251
- package/src/types/workplace.ts +65 -41
- package/src/utils.ts +3 -3
package/lib/types/contact.d.ts
CHANGED
|
@@ -1,1209 +1,1284 @@
|
|
|
1
|
-
import
|
|
2
|
-
import { Pagination } from '../internal';
|
|
1
|
+
import * as Lark from '.';
|
|
2
|
+
import { Paginated, Pagination } from '../internal';
|
|
3
3
|
declare module '../internal' {
|
|
4
4
|
interface Internal {
|
|
5
|
-
|
|
6
|
-
* 获取通讯录授权范围
|
|
7
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/scope/list
|
|
8
|
-
*/
|
|
9
|
-
listContactScope(query?: ListContactScopeQuery): Promise<ListContactScopeResponse>;
|
|
10
|
-
/**
|
|
11
|
-
* 创建用户
|
|
12
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/create
|
|
13
|
-
*/
|
|
14
|
-
createContactUser(body: CreateContactUserRequest, query?: CreateContactUserQuery): Promise<CreateContactUserResponse>;
|
|
15
|
-
/**
|
|
16
|
-
* 修改用户部分信息
|
|
17
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/patch
|
|
18
|
-
*/
|
|
19
|
-
patchContactUser(user_id: string, body: PatchContactUserRequest, query?: PatchContactUserQuery): Promise<PatchContactUserResponse>;
|
|
20
|
-
/**
|
|
21
|
-
* 更新用户 ID
|
|
22
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/update_user_id
|
|
23
|
-
*/
|
|
24
|
-
updateUserIdContactUser(user_id: string, body: UpdateUserIdContactUserRequest, query?: UpdateUserIdContactUserQuery): Promise<void>;
|
|
25
|
-
/**
|
|
26
|
-
* 获取单个用户信息
|
|
27
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get
|
|
28
|
-
*/
|
|
29
|
-
getContactUser(user_id: string, query?: GetContactUserQuery): Promise<GetContactUserResponse>;
|
|
30
|
-
/**
|
|
31
|
-
* 批量获取用户信息
|
|
32
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch
|
|
33
|
-
*/
|
|
34
|
-
batchContactUser(query?: BatchContactUserQuery): Promise<BatchContactUserResponse>;
|
|
35
|
-
/**
|
|
36
|
-
* 获取部门直属用户列表
|
|
37
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/find_by_department
|
|
38
|
-
*/
|
|
39
|
-
findByDepartmentContactUser(query?: FindByDepartmentContactUserQuery): Paginated<User>;
|
|
40
|
-
/**
|
|
41
|
-
* 通过手机号或邮箱获取用户 ID
|
|
42
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id
|
|
43
|
-
*/
|
|
44
|
-
batchGetIdContactUser(body: BatchGetIdContactUserRequest, query?: BatchGetIdContactUserQuery): Promise<BatchGetIdContactUserResponse>;
|
|
45
|
-
/**
|
|
46
|
-
* 删除用户
|
|
47
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/delete
|
|
48
|
-
*/
|
|
49
|
-
deleteContactUser(user_id: string, body: DeleteContactUserRequest, query?: DeleteContactUserQuery): Promise<void>;
|
|
50
|
-
/**
|
|
51
|
-
* 恢复已删除用户
|
|
52
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/resurrect
|
|
53
|
-
*/
|
|
54
|
-
resurrectContactUser(user_id: string, body: ResurrectContactUserRequest, query?: ResurrectContactUserQuery): Promise<void>;
|
|
55
|
-
/**
|
|
56
|
-
* 创建用户组
|
|
57
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/create
|
|
58
|
-
*/
|
|
59
|
-
createContactGroup(body: CreateContactGroupRequest, query?: CreateContactGroupQuery): Promise<CreateContactGroupResponse>;
|
|
60
|
-
/**
|
|
61
|
-
* 更新用户组
|
|
62
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/patch
|
|
63
|
-
*/
|
|
64
|
-
patchContactGroup(group_id: string, body: PatchContactGroupRequest, query?: PatchContactGroupQuery): Promise<void>;
|
|
65
|
-
/**
|
|
66
|
-
* 查询指定用户组
|
|
67
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/get
|
|
68
|
-
*/
|
|
69
|
-
getContactGroup(group_id: string, query?: GetContactGroupQuery): Promise<GetContactGroupResponse>;
|
|
70
|
-
/**
|
|
71
|
-
* 查询用户组列表
|
|
72
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/simplelist
|
|
73
|
-
*/
|
|
74
|
-
simplelistContactGroup(query?: SimplelistContactGroupQuery): Paginated<Group, 'grouplist'>;
|
|
75
|
-
/**
|
|
76
|
-
* 查询用户所属用户组
|
|
77
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/member_belong
|
|
78
|
-
*/
|
|
79
|
-
memberBelongContactGroup(query?: MemberBelongContactGroupQuery): Paginated<string, 'group_list'>;
|
|
80
|
-
/**
|
|
81
|
-
* 删除用户组
|
|
82
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/delete
|
|
83
|
-
*/
|
|
84
|
-
deleteContactGroup(group_id: string): Promise<void>;
|
|
85
|
-
/**
|
|
86
|
-
* 获取企业自定义用户字段
|
|
87
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/custom_attr/list
|
|
88
|
-
*/
|
|
89
|
-
listContactCustomAttr(query?: Pagination): Paginated<CustomAttr>;
|
|
90
|
-
/**
|
|
91
|
-
* 新增人员类型
|
|
92
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/create
|
|
93
|
-
*/
|
|
94
|
-
createContactEmployeeTypeEnum(body: CreateContactEmployeeTypeEnumRequest): Promise<CreateContactEmployeeTypeEnumResponse>;
|
|
95
|
-
/**
|
|
96
|
-
* 更新人员类型
|
|
97
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/update
|
|
98
|
-
*/
|
|
99
|
-
updateContactEmployeeTypeEnum(enum_id: string, body: UpdateContactEmployeeTypeEnumRequest): Promise<UpdateContactEmployeeTypeEnumResponse>;
|
|
100
|
-
/**
|
|
101
|
-
* 查询人员类型
|
|
102
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/list
|
|
103
|
-
*/
|
|
104
|
-
listContactEmployeeTypeEnum(query?: Pagination): Paginated<EmployeeTypeEnum>;
|
|
105
|
-
/**
|
|
106
|
-
* 删除人员类型
|
|
107
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/delete
|
|
108
|
-
*/
|
|
109
|
-
deleteContactEmployeeTypeEnum(enum_id: string): Promise<void>;
|
|
110
|
-
/**
|
|
111
|
-
* 创建部门
|
|
112
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/create
|
|
113
|
-
*/
|
|
114
|
-
createContactDepartment(body: CreateContactDepartmentRequest, query?: CreateContactDepartmentQuery): Promise<CreateContactDepartmentResponse>;
|
|
115
|
-
/**
|
|
116
|
-
* 修改部门部分信息
|
|
117
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/patch
|
|
118
|
-
*/
|
|
119
|
-
patchContactDepartment(department_id: string, body: PatchContactDepartmentRequest, query?: PatchContactDepartmentQuery): Promise<PatchContactDepartmentResponse>;
|
|
120
|
-
/**
|
|
121
|
-
* 更新部门所有信息
|
|
122
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/update
|
|
123
|
-
*/
|
|
124
|
-
updateContactDepartment(department_id: string, body: UpdateContactDepartmentRequest, query?: UpdateContactDepartmentQuery): Promise<UpdateContactDepartmentResponse>;
|
|
125
|
-
/**
|
|
126
|
-
* 更新部门 ID
|
|
127
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/update_department_id
|
|
128
|
-
*/
|
|
129
|
-
updateDepartmentIdContactDepartment(department_id: string, body: UpdateDepartmentIdContactDepartmentRequest, query?: UpdateDepartmentIdContactDepartmentQuery): Promise<void>;
|
|
130
|
-
/**
|
|
131
|
-
* 部门群转为普通群
|
|
132
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/unbind_department_chat
|
|
133
|
-
*/
|
|
134
|
-
unbindDepartmentChatContactDepartment(body: UnbindDepartmentChatContactDepartmentRequest, query?: UnbindDepartmentChatContactDepartmentQuery): Promise<void>;
|
|
135
|
-
/**
|
|
136
|
-
* 获取单个部门信息
|
|
137
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/get
|
|
138
|
-
*/
|
|
139
|
-
getContactDepartment(department_id: string, query?: GetContactDepartmentQuery): Promise<GetContactDepartmentResponse>;
|
|
140
|
-
/**
|
|
141
|
-
* 批量获取部门信息
|
|
142
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/batch
|
|
143
|
-
*/
|
|
144
|
-
batchContactDepartment(query?: BatchContactDepartmentQuery): Promise<BatchContactDepartmentResponse>;
|
|
145
|
-
/**
|
|
146
|
-
* 获取子部门列表
|
|
147
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/children
|
|
148
|
-
*/
|
|
149
|
-
childrenContactDepartment(department_id: string, query?: ChildrenContactDepartmentQuery): Paginated<Department>;
|
|
150
|
-
/**
|
|
151
|
-
* 获取父部门信息
|
|
152
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/parent
|
|
153
|
-
*/
|
|
154
|
-
parentContactDepartment(query?: ParentContactDepartmentQuery): Paginated<Department>;
|
|
155
|
-
/**
|
|
156
|
-
* 搜索部门
|
|
157
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/search
|
|
158
|
-
*/
|
|
159
|
-
searchContactDepartment(body: SearchContactDepartmentRequest, query?: SearchContactDepartmentQuery): Paginated<Department>;
|
|
160
|
-
/**
|
|
161
|
-
* 删除部门
|
|
162
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/delete
|
|
163
|
-
*/
|
|
164
|
-
deleteContactDepartment(department_id: string, query?: DeleteContactDepartmentQuery): Promise<void>;
|
|
165
|
-
/**
|
|
166
|
-
* 创建单位
|
|
167
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/create
|
|
168
|
-
*/
|
|
169
|
-
createContactUnit(body: CreateContactUnitRequest): Promise<CreateContactUnitResponse>;
|
|
170
|
-
/**
|
|
171
|
-
* 修改单位信息
|
|
172
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/patch
|
|
173
|
-
*/
|
|
174
|
-
patchContactUnit(unit_id: string, body: PatchContactUnitRequest): Promise<void>;
|
|
175
|
-
/**
|
|
176
|
-
* 建立部门与单位的绑定关系
|
|
177
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/bind_department
|
|
178
|
-
*/
|
|
179
|
-
bindDepartmentContactUnit(body: BindDepartmentContactUnitRequest): Promise<void>;
|
|
180
|
-
/**
|
|
181
|
-
* 解除部门与单位的绑定关系
|
|
182
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/unbind_department
|
|
183
|
-
*/
|
|
184
|
-
unbindDepartmentContactUnit(body: UnbindDepartmentContactUnitRequest): Promise<void>;
|
|
185
|
-
/**
|
|
186
|
-
* 获取单位绑定的部门列表
|
|
187
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/list_department
|
|
188
|
-
*/
|
|
189
|
-
listDepartmentContactUnit(query?: ListDepartmentContactUnitQuery): Paginated<UnitDepartment, 'departmentlist'>;
|
|
190
|
-
/**
|
|
191
|
-
* 获取单位信息
|
|
192
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/get
|
|
193
|
-
*/
|
|
194
|
-
getContactUnit(unit_id: string): Promise<GetContactUnitResponse>;
|
|
195
|
-
/**
|
|
196
|
-
* 获取单位列表
|
|
197
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/list
|
|
198
|
-
*/
|
|
199
|
-
listContactUnit(query?: Pagination): Paginated<Unit, 'unitlist'>;
|
|
200
|
-
/**
|
|
201
|
-
* 删除单位
|
|
202
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/delete
|
|
203
|
-
*/
|
|
204
|
-
deleteContactUnit(unit_id: string): Promise<void>;
|
|
205
|
-
/**
|
|
206
|
-
* 添加用户组成员
|
|
207
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/add
|
|
208
|
-
*/
|
|
209
|
-
addContactGroupMember(group_id: string, body: AddContactGroupMemberRequest): Promise<void>;
|
|
210
|
-
/**
|
|
211
|
-
* 批量添加用户组成员
|
|
212
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/batch_add
|
|
213
|
-
*/
|
|
214
|
-
batchAddContactGroupMember(group_id: string, body: BatchAddContactGroupMemberRequest): Promise<BatchAddContactGroupMemberResponse>;
|
|
215
|
-
/**
|
|
216
|
-
* 查询用户组成员列表
|
|
217
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/simplelist
|
|
218
|
-
*/
|
|
219
|
-
simplelistContactGroupMember(group_id: string, query?: SimplelistContactGroupMemberQuery): Paginated<Memberlist, 'memberlist'>;
|
|
220
|
-
/**
|
|
221
|
-
* 移除用户组成员
|
|
222
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/remove
|
|
223
|
-
*/
|
|
224
|
-
removeContactGroupMember(group_id: string, body: RemoveContactGroupMemberRequest): Promise<void>;
|
|
225
|
-
/**
|
|
226
|
-
* 批量移除用户组成员
|
|
227
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/batch_remove
|
|
228
|
-
*/
|
|
229
|
-
batchRemoveContactGroupMember(group_id: string, body: BatchRemoveContactGroupMemberRequest): Promise<void>;
|
|
230
|
-
/**
|
|
231
|
-
* 创建角色
|
|
232
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role/create
|
|
233
|
-
*/
|
|
234
|
-
createContactFunctionalRole(body: CreateContactFunctionalRoleRequest): Promise<CreateContactFunctionalRoleResponse>;
|
|
235
|
-
/**
|
|
236
|
-
* 修改角色名称
|
|
237
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role/update
|
|
238
|
-
*/
|
|
239
|
-
updateContactFunctionalRole(role_id: string, body: UpdateContactFunctionalRoleRequest): Promise<void>;
|
|
240
|
-
/**
|
|
241
|
-
* 删除角色
|
|
242
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role/delete
|
|
243
|
-
*/
|
|
244
|
-
deleteContactFunctionalRole(role_id: string): Promise<void>;
|
|
245
|
-
/**
|
|
246
|
-
* 批量添加角色成员
|
|
247
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/batch_create
|
|
248
|
-
*/
|
|
249
|
-
batchCreateContactFunctionalRoleMember(role_id: string, body: BatchCreateContactFunctionalRoleMemberRequest, query?: BatchCreateContactFunctionalRoleMemberQuery): Promise<BatchCreateContactFunctionalRoleMemberResponse>;
|
|
250
|
-
/**
|
|
251
|
-
* 批量设置角色成员管理范围
|
|
252
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/scopes
|
|
253
|
-
*/
|
|
254
|
-
scopesContactFunctionalRoleMember(role_id: string, body: ScopesContactFunctionalRoleMemberRequest, query?: ScopesContactFunctionalRoleMemberQuery): Promise<ScopesContactFunctionalRoleMemberResponse>;
|
|
255
|
-
/**
|
|
256
|
-
* 查询角色下某个成员的管理范围
|
|
257
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/get
|
|
258
|
-
*/
|
|
259
|
-
getContactFunctionalRoleMember(role_id: string, member_id: string, query?: GetContactFunctionalRoleMemberQuery): Promise<GetContactFunctionalRoleMemberResponse>;
|
|
260
|
-
/**
|
|
261
|
-
* 查询角色下的所有成员信息
|
|
262
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/list
|
|
263
|
-
*/
|
|
264
|
-
listContactFunctionalRoleMember(role_id: string, query?: ListContactFunctionalRoleMemberQuery): Paginated<FunctionalRoleMember, 'members'>;
|
|
265
|
-
/**
|
|
266
|
-
* 删除角色下的成员
|
|
267
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/batch_delete
|
|
268
|
-
*/
|
|
269
|
-
batchDeleteContactFunctionalRoleMember(role_id: string, body: BatchDeleteContactFunctionalRoleMemberRequest, query?: BatchDeleteContactFunctionalRoleMemberQuery): Promise<BatchDeleteContactFunctionalRoleMemberResponse>;
|
|
270
|
-
/**
|
|
271
|
-
* 创建职级
|
|
272
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/create
|
|
273
|
-
*/
|
|
274
|
-
createContactJobLevel(body: CreateContactJobLevelRequest): Promise<CreateContactJobLevelResponse>;
|
|
275
|
-
/**
|
|
276
|
-
* 更新职级
|
|
277
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/update
|
|
278
|
-
*/
|
|
279
|
-
updateContactJobLevel(job_level_id: string, body: UpdateContactJobLevelRequest): Promise<UpdateContactJobLevelResponse>;
|
|
280
|
-
/**
|
|
281
|
-
* 获取单个职级信息
|
|
282
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/get
|
|
283
|
-
*/
|
|
284
|
-
getContactJobLevel(job_level_id: string): Promise<GetContactJobLevelResponse>;
|
|
285
|
-
/**
|
|
286
|
-
* 获取租户职级列表
|
|
287
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/list
|
|
288
|
-
*/
|
|
289
|
-
listContactJobLevel(query?: ListContactJobLevelQuery): Paginated<JobLevel>;
|
|
290
|
-
/**
|
|
291
|
-
* 删除职级
|
|
292
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/delete
|
|
293
|
-
*/
|
|
294
|
-
deleteContactJobLevel(job_level_id: string): Promise<void>;
|
|
295
|
-
/**
|
|
296
|
-
* 创建序列
|
|
297
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/create
|
|
298
|
-
*/
|
|
299
|
-
createContactJobFamily(body: CreateContactJobFamilyRequest): Promise<CreateContactJobFamilyResponse>;
|
|
300
|
-
/**
|
|
301
|
-
* 更新序列
|
|
302
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/update
|
|
303
|
-
*/
|
|
304
|
-
updateContactJobFamily(job_family_id: string, body: UpdateContactJobFamilyRequest): Promise<UpdateContactJobFamilyResponse>;
|
|
305
|
-
/**
|
|
306
|
-
* 获取单个序列信息
|
|
307
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/get
|
|
308
|
-
*/
|
|
309
|
-
getContactJobFamily(job_family_id: string): Promise<GetContactJobFamilyResponse>;
|
|
310
|
-
/**
|
|
311
|
-
* 获取租户序列列表
|
|
312
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/list
|
|
313
|
-
*/
|
|
314
|
-
listContactJobFamily(query?: ListContactJobFamilyQuery): Paginated<JobFamily>;
|
|
315
|
-
/**
|
|
316
|
-
* 删除序列
|
|
317
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/delete
|
|
318
|
-
*/
|
|
319
|
-
deleteContactJobFamily(job_family_id: string): Promise<void>;
|
|
320
|
-
/**
|
|
321
|
-
* 获取单个职务信息
|
|
322
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_title/get
|
|
323
|
-
*/
|
|
324
|
-
getContactJobTitle(job_title_id: string): Promise<GetContactJobTitleResponse>;
|
|
325
|
-
/**
|
|
326
|
-
* 获取租户职务列表
|
|
327
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_title/list
|
|
328
|
-
*/
|
|
329
|
-
listContactJobTitle(query?: Pagination): Paginated<JobTitle>;
|
|
330
|
-
/**
|
|
331
|
-
* 获取单个工作城市信息
|
|
332
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/work_city/get
|
|
333
|
-
*/
|
|
334
|
-
getContactWorkCity(work_city_id: string): Promise<GetContactWorkCityResponse>;
|
|
335
|
-
/**
|
|
336
|
-
* 获取租户工作城市列表
|
|
337
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/work_city/list
|
|
338
|
-
*/
|
|
339
|
-
listContactWorkCity(query?: Pagination): Paginated<WorkCity>;
|
|
340
|
-
/**
|
|
341
|
-
* 获取用户列表
|
|
342
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/list
|
|
343
|
-
*/
|
|
344
|
-
listContactUser(query?: ListContactUserQuery): Paginated<User>;
|
|
345
|
-
/**
|
|
346
|
-
* 更新用户所有信息
|
|
347
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/update
|
|
348
|
-
*/
|
|
349
|
-
updateContactUser(user_id: string, body: UpdateContactUserRequest, query?: UpdateContactUserQuery): Promise<UpdateContactUserResponse>;
|
|
350
|
-
/**
|
|
351
|
-
* 获取部门信息列表
|
|
352
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/list
|
|
353
|
-
*/
|
|
354
|
-
listContactDepartment(query?: ListContactDepartmentQuery): Paginated<Department>;
|
|
5
|
+
contact: Contact.Methods;
|
|
355
6
|
}
|
|
356
7
|
}
|
|
357
|
-
export
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
}
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
}
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
}
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
}
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
}
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
}
|
|
763
|
-
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
}
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
}
|
|
943
|
-
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
|
|
1078
|
-
|
|
1079
|
-
|
|
1080
|
-
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
|
-
|
|
1084
|
-
|
|
1085
|
-
|
|
1086
|
-
|
|
1087
|
-
|
|
1088
|
-
|
|
1089
|
-
|
|
1090
|
-
|
|
1091
|
-
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
|
|
1097
|
-
|
|
1098
|
-
|
|
1099
|
-
|
|
1100
|
-
|
|
1101
|
-
|
|
1102
|
-
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
|
|
1150
|
-
|
|
1151
|
-
|
|
1152
|
-
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
|
|
1156
|
-
|
|
1157
|
-
|
|
1158
|
-
|
|
1159
|
-
|
|
1160
|
-
|
|
1161
|
-
|
|
1162
|
-
|
|
1163
|
-
|
|
1164
|
-
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
|
|
1172
|
-
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
|
|
1179
|
-
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
|
|
1185
|
-
|
|
1186
|
-
|
|
1187
|
-
|
|
1188
|
-
|
|
1189
|
-
|
|
1190
|
-
|
|
1191
|
-
|
|
1192
|
-
|
|
1193
|
-
|
|
1194
|
-
|
|
1195
|
-
|
|
1196
|
-
|
|
1197
|
-
|
|
1198
|
-
|
|
1199
|
-
|
|
1200
|
-
|
|
1201
|
-
|
|
1202
|
-
|
|
1203
|
-
|
|
1204
|
-
|
|
1205
|
-
|
|
1206
|
-
|
|
1207
|
-
|
|
1208
|
-
|
|
8
|
+
export declare namespace Contact {
|
|
9
|
+
interface Methods {
|
|
10
|
+
scope: Scope.Methods;
|
|
11
|
+
user: User.Methods;
|
|
12
|
+
group: Group.Methods;
|
|
13
|
+
customAttr: CustomAttr.Methods;
|
|
14
|
+
employeeTypeEnum: EmployeeTypeEnum.Methods;
|
|
15
|
+
department: Department.Methods;
|
|
16
|
+
unit: Unit.Methods;
|
|
17
|
+
functionalRole: FunctionalRole.Methods;
|
|
18
|
+
jobLevel: JobLevel.Methods;
|
|
19
|
+
jobFamily: JobFamily.Methods;
|
|
20
|
+
jobTitle: JobTitle.Methods;
|
|
21
|
+
workCity: WorkCity.Methods;
|
|
22
|
+
}
|
|
23
|
+
namespace Scope {
|
|
24
|
+
interface Methods {
|
|
25
|
+
/**
|
|
26
|
+
* 获取通讯录授权范围
|
|
27
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/scope/list
|
|
28
|
+
*/
|
|
29
|
+
list(query?: ListQuery): Promise<ListResponse>;
|
|
30
|
+
}
|
|
31
|
+
interface ListQuery extends Pagination {
|
|
32
|
+
/** 返回值的用户ID的类型 */
|
|
33
|
+
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
34
|
+
/** 返回值的部门ID的类型 */
|
|
35
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
36
|
+
}
|
|
37
|
+
interface ListResponse {
|
|
38
|
+
/** 已授权部门列表,授权范围为全员可见时返回的是当前企业的所有一级部门列表 */
|
|
39
|
+
department_ids?: string[];
|
|
40
|
+
/** 已授权用户列表,应用申请了获取用户user_id 权限时返回;当授权范围为全员可见时返回的是当前企业所有顶级部门用户列表 */
|
|
41
|
+
user_ids?: string[];
|
|
42
|
+
/** 已授权的用户组,授权范围为全员可见时返回的是当前企业所有用户组 */
|
|
43
|
+
group_ids?: string[];
|
|
44
|
+
/** 是否还有更多项 */
|
|
45
|
+
has_more?: boolean;
|
|
46
|
+
/** 分页标记,当 has_more 为 true 时,会同时返回新的 page_token */
|
|
47
|
+
page_token?: string;
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
namespace User {
|
|
51
|
+
interface Methods {
|
|
52
|
+
/**
|
|
53
|
+
* 创建用户
|
|
54
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/create
|
|
55
|
+
*/
|
|
56
|
+
create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
|
|
57
|
+
/**
|
|
58
|
+
* 修改用户部分信息
|
|
59
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/patch
|
|
60
|
+
*/
|
|
61
|
+
patch(user_id: string, body: PatchRequest, query?: PatchQuery): Promise<PatchResponse>;
|
|
62
|
+
/**
|
|
63
|
+
* 更新用户 ID
|
|
64
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/update_user_id
|
|
65
|
+
*/
|
|
66
|
+
updateUserId(user_id: string, body: UpdateUserIdRequest, query?: UpdateUserIdQuery): Promise<void>;
|
|
67
|
+
/**
|
|
68
|
+
* 获取单个用户信息
|
|
69
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get
|
|
70
|
+
*/
|
|
71
|
+
get(user_id: string, query?: GetQuery): Promise<GetResponse>;
|
|
72
|
+
/**
|
|
73
|
+
* 批量获取用户信息
|
|
74
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch
|
|
75
|
+
*/
|
|
76
|
+
batch(query?: BatchQuery): Promise<BatchResponse>;
|
|
77
|
+
/**
|
|
78
|
+
* 获取部门直属用户列表
|
|
79
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/find_by_department
|
|
80
|
+
*/
|
|
81
|
+
findByDepartment(query?: FindByDepartmentQuery): Paginated<Lark.User>;
|
|
82
|
+
/**
|
|
83
|
+
* 通过手机号或邮箱获取用户 ID
|
|
84
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id
|
|
85
|
+
*/
|
|
86
|
+
batchGetId(body: BatchGetIdRequest, query?: BatchGetIdQuery): Promise<BatchGetIdResponse>;
|
|
87
|
+
/**
|
|
88
|
+
* 删除用户
|
|
89
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/delete
|
|
90
|
+
*/
|
|
91
|
+
delete(user_id: string, body: DeleteRequest, query?: DeleteQuery): Promise<void>;
|
|
92
|
+
/**
|
|
93
|
+
* 恢复已删除用户
|
|
94
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/resurrect
|
|
95
|
+
*/
|
|
96
|
+
resurrect(user_id: string, body: ResurrectRequest, query?: ResurrectQuery): Promise<void>;
|
|
97
|
+
/**
|
|
98
|
+
* 获取用户列表
|
|
99
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/list
|
|
100
|
+
*/
|
|
101
|
+
list(query?: ListQuery): Paginated<Lark.User>;
|
|
102
|
+
/**
|
|
103
|
+
* 更新用户所有信息
|
|
104
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/update
|
|
105
|
+
*/
|
|
106
|
+
update(user_id: string, body: UpdateRequest, query?: UpdateQuery): Promise<UpdateResponse>;
|
|
107
|
+
}
|
|
108
|
+
const enum CreateRequestGender {
|
|
109
|
+
/** 保密 */
|
|
110
|
+
Unkown = 0,
|
|
111
|
+
/** 男 */
|
|
112
|
+
Male = 1,
|
|
113
|
+
/** 女 */
|
|
114
|
+
Female = 2,
|
|
115
|
+
/** 其他 */
|
|
116
|
+
Others = 3
|
|
117
|
+
}
|
|
118
|
+
interface CreateRequest {
|
|
119
|
+
/** 租户内用户的唯一标识 */
|
|
120
|
+
user_id?: string;
|
|
121
|
+
/** 用户名 */
|
|
122
|
+
name: string;
|
|
123
|
+
/** 英文名 */
|
|
124
|
+
en_name?: string;
|
|
125
|
+
/** 别名 */
|
|
126
|
+
nickname?: string;
|
|
127
|
+
/** 邮箱 */
|
|
128
|
+
email?: string;
|
|
129
|
+
/** 手机号 */
|
|
130
|
+
mobile: string;
|
|
131
|
+
/** 手机号码可见性,true 为可见,false 为不可见,目前默认为 true。不可见时,组织员工将无法查看该员工的手机号码 */
|
|
132
|
+
mobile_visible?: boolean;
|
|
133
|
+
/** 性别 */
|
|
134
|
+
gender?: CreateRequestGender;
|
|
135
|
+
/** 头像的文件Key */
|
|
136
|
+
avatar_key?: string;
|
|
137
|
+
/** 用户所在的部门 */
|
|
138
|
+
department_ids: string[];
|
|
139
|
+
/** 用户的上级领导 */
|
|
140
|
+
leader_user_id?: string;
|
|
141
|
+
/** 城市 */
|
|
142
|
+
city?: string;
|
|
143
|
+
/** 国家 */
|
|
144
|
+
country?: string;
|
|
145
|
+
/** 工位 */
|
|
146
|
+
work_station?: string;
|
|
147
|
+
/** 入职时间 */
|
|
148
|
+
join_time?: number;
|
|
149
|
+
/** 工号 */
|
|
150
|
+
employee_no?: string;
|
|
151
|
+
/** 员工类型 */
|
|
152
|
+
employee_type: number;
|
|
153
|
+
/** 用户排序信息 */
|
|
154
|
+
orders?: Lark.UserOrder[];
|
|
155
|
+
/** 自定义属性 */
|
|
156
|
+
custom_attrs?: Lark.UserCustomAttr[];
|
|
157
|
+
/** 企业邮箱 */
|
|
158
|
+
enterprise_email?: string;
|
|
159
|
+
/** 职务 */
|
|
160
|
+
job_title?: string;
|
|
161
|
+
/** 数据驻留地 */
|
|
162
|
+
geo?: string;
|
|
163
|
+
/** 职级ID */
|
|
164
|
+
job_level_id?: string;
|
|
165
|
+
/** 序列ID */
|
|
166
|
+
job_family_id?: string;
|
|
167
|
+
/** 分配给用户的席位ID列表 */
|
|
168
|
+
subscription_ids?: string[];
|
|
169
|
+
/** 虚线上级ID */
|
|
170
|
+
dotted_line_leader_user_ids?: string[];
|
|
171
|
+
}
|
|
172
|
+
interface CreateQuery {
|
|
173
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
174
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
175
|
+
/** 此次调用中使用的部门ID的类型。不同 ID 的说明参见[部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
|
|
176
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
177
|
+
/** 用于幂等判断是否为同一请求,避免重复创建。字符串类型,自行生成。 */
|
|
178
|
+
client_token?: string;
|
|
179
|
+
}
|
|
180
|
+
interface CreateResponse {
|
|
181
|
+
user?: Lark.User;
|
|
182
|
+
}
|
|
183
|
+
const enum PatchRequestGender {
|
|
184
|
+
/** 保密 */
|
|
185
|
+
Unkown = 0,
|
|
186
|
+
/** 男 */
|
|
187
|
+
Male = 1,
|
|
188
|
+
/** 女 */
|
|
189
|
+
Female = 2,
|
|
190
|
+
/** 其他 */
|
|
191
|
+
Others = 3
|
|
192
|
+
}
|
|
193
|
+
interface PatchRequest {
|
|
194
|
+
/** 用户名称 */
|
|
195
|
+
name?: string;
|
|
196
|
+
/** 英文名 */
|
|
197
|
+
en_name?: string;
|
|
198
|
+
/** 别名 */
|
|
199
|
+
nickname?: string;
|
|
200
|
+
/** 邮箱 */
|
|
201
|
+
email?: string;
|
|
202
|
+
/** 用户手机号 */
|
|
203
|
+
mobile?: string;
|
|
204
|
+
/** 手机号码可见性,true 为可见,false 为不可见,目前默认为 true。不可见时,组织员工将无法查看该员工的手机号码 */
|
|
205
|
+
mobile_visible?: boolean;
|
|
206
|
+
/** 性别 */
|
|
207
|
+
gender?: PatchRequestGender;
|
|
208
|
+
/** 头像的文件Key */
|
|
209
|
+
avatar_key?: string;
|
|
210
|
+
/** 用户所在部门ID */
|
|
211
|
+
department_ids?: string[];
|
|
212
|
+
/** 用户直属上级 */
|
|
213
|
+
leader_user_id?: string;
|
|
214
|
+
/** 城市 */
|
|
215
|
+
city?: string;
|
|
216
|
+
/** 国家 */
|
|
217
|
+
country?: string;
|
|
218
|
+
/** 工位 */
|
|
219
|
+
work_station?: string;
|
|
220
|
+
/** 入职时间 */
|
|
221
|
+
join_time?: number;
|
|
222
|
+
/** 工号 */
|
|
223
|
+
employee_no?: string;
|
|
224
|
+
/** 员工类型 */
|
|
225
|
+
employee_type?: number;
|
|
226
|
+
/** 用户排序信息 */
|
|
227
|
+
orders?: Lark.UserOrder[];
|
|
228
|
+
/** 自定义属性 */
|
|
229
|
+
custom_attrs?: Lark.UserCustomAttr[];
|
|
230
|
+
/** 企业邮箱 */
|
|
231
|
+
enterprise_email?: string;
|
|
232
|
+
/** 职务 */
|
|
233
|
+
job_title?: string;
|
|
234
|
+
/** 是否冻结用户 */
|
|
235
|
+
is_frozen?: boolean;
|
|
236
|
+
/** 职级ID */
|
|
237
|
+
job_level_id?: string;
|
|
238
|
+
/** 序列ID */
|
|
239
|
+
job_family_id?: string;
|
|
240
|
+
/** 分配给用户的席位ID列表 */
|
|
241
|
+
subscription_ids?: string[];
|
|
242
|
+
/** 虚线上级ID */
|
|
243
|
+
dotted_line_leader_user_ids?: string[];
|
|
244
|
+
}
|
|
245
|
+
interface PatchQuery {
|
|
246
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
247
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
248
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
249
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
250
|
+
}
|
|
251
|
+
interface PatchResponse {
|
|
252
|
+
user?: Lark.User;
|
|
253
|
+
}
|
|
254
|
+
interface UpdateUserIdRequest {
|
|
255
|
+
/** 自定义新用户ID */
|
|
256
|
+
new_user_id: string;
|
|
257
|
+
}
|
|
258
|
+
interface UpdateUserIdQuery {
|
|
259
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
260
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
261
|
+
}
|
|
262
|
+
interface GetQuery {
|
|
263
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
264
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
265
|
+
/** 此次调用中使用的部门ID的类型不同 ID 的说明 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
|
|
266
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
267
|
+
}
|
|
268
|
+
interface GetResponse {
|
|
269
|
+
user?: Lark.User;
|
|
270
|
+
}
|
|
271
|
+
interface BatchQuery {
|
|
272
|
+
/** 要查询的用户ID列表 */
|
|
273
|
+
user_ids: string[];
|
|
274
|
+
/** 指定请求中用户ID类型 */
|
|
275
|
+
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
276
|
+
/** 指定查询结果中用户关联的部门ID类型 */
|
|
277
|
+
department_id_type?: 'open_department_id' | 'department_id';
|
|
278
|
+
}
|
|
279
|
+
interface BatchResponse {
|
|
280
|
+
/** 查询到的用户信息,其中异常的用户ID不返回结果。 */
|
|
281
|
+
items?: Lark.User[];
|
|
282
|
+
}
|
|
283
|
+
interface FindByDepartmentQuery extends Pagination {
|
|
284
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
285
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
286
|
+
/** 此次调用中使用的部门ID的类型部门ID类型的区别参见[部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
|
|
287
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
288
|
+
/** 填写该字段表示获取该部门下用户,必填。根部门的部门ID为0。ID值与查询参数中的department_id_type 对应。不同 ID 的说明与department_id的获取方式参见 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
|
|
289
|
+
department_id: string;
|
|
290
|
+
}
|
|
291
|
+
interface BatchGetIdRequest {
|
|
292
|
+
/** 要查询的用户邮箱,最多 50 条。注意,emails与mobiles相互独立,每条用户邮箱返回对应的用户ID。本接口返回的用户ID数量为emails数量与mobiles数量的和。 */
|
|
293
|
+
emails?: string[];
|
|
294
|
+
/** 要查询的用户手机号,最多 50 条。注意1. emails与mobiles相互独立,每条用户手机号返回对应的用户ID。2. 非中国大陆地区的手机号需要添加以 “+” 开头的国家 / 地区代码。 */
|
|
295
|
+
mobiles?: string[];
|
|
296
|
+
/** 查询结果包含离职员工,可查询离职用户的ID */
|
|
297
|
+
include_resigned?: boolean;
|
|
298
|
+
}
|
|
299
|
+
interface BatchGetIdQuery {
|
|
300
|
+
/** 返回的用户ID的类型 */
|
|
301
|
+
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
302
|
+
}
|
|
303
|
+
interface BatchGetIdResponse {
|
|
304
|
+
/** 手机号或者邮箱对应的用户id信息 */
|
|
305
|
+
user_list?: Lark.UserContactInfo[];
|
|
306
|
+
}
|
|
307
|
+
interface DeleteRequest {
|
|
308
|
+
/** 部门群接收者。被删除用户为部门群群主时,转让群主给指定接收者,不指定接收者则默认转让给群内第一个入群的人 */
|
|
309
|
+
department_chat_acceptor_user_id?: string;
|
|
310
|
+
/** 外部群接收者。被删除用户为外部群群主时,转让群主给指定接收者,不指定接收者则默认转让给群内与被删除用户在同一组织的第一个入群的人,如果组织内只有该用户在群里,则解散外部群 */
|
|
311
|
+
external_chat_acceptor_user_id?: string;
|
|
312
|
+
/** 文档接收者。用户被删除时,其拥有的文档转让给接收者。不指定接收者则默认转让给直属上级,如果无直属上级则将文档资源保留在该用户名下。 */
|
|
313
|
+
docs_acceptor_user_id?: string;
|
|
314
|
+
/** 日程接收者。用户被删除时,其拥有的日程转让给接收者,不指定接收者则默认转让给直属上级,如果无直属上级则直接删除日程资源。 */
|
|
315
|
+
calendar_acceptor_user_id?: string;
|
|
316
|
+
/** 应用接受者。用户被删除时,其创建的应用转让给接收者,不指定接收者则默认转让给直属上级。如果无直属上级则保留应用在该用户名下,但该用户无法登录开发者后台进行应用管理,管理员可以在管理后台手动转移应用给其他人。 */
|
|
317
|
+
application_acceptor_user_id?: string;
|
|
318
|
+
/** 妙记接收者。用户被删除时,其拥有的妙记资源转让给接收者。如果不指定接收者,则默认转让给直属上级。如果无直属上级则将妙记保留在该用户名下。 */
|
|
319
|
+
minutes_acceptor_user_id?: string;
|
|
320
|
+
/** 飞书问卷接收者。用户被删除时,其拥有的飞书问卷资源转让给接收者,不指定接收者则默认转让给直属上级,如果无直属上级则直接删除飞书问卷资源。 */
|
|
321
|
+
survey_acceptor_user_id?: string;
|
|
322
|
+
/** 用户邮件资源处理方式。用户被删除时,根据传递的操作指令对其拥有的邮件资源做对应处理。未传递指令时默认将邮件资源转让给直属上级,如果无直属上级则保留邮件资源在该用户名下。 */
|
|
323
|
+
email_acceptor?: Lark.ResourceAcceptor;
|
|
324
|
+
/** 用户集成平台资源接收者 */
|
|
325
|
+
anycross_acceptor_user_id?: string;
|
|
326
|
+
}
|
|
327
|
+
interface DeleteQuery {
|
|
328
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
329
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
330
|
+
}
|
|
331
|
+
interface ResurrectRequest {
|
|
332
|
+
/** 指定恢复后用户所在部门 */
|
|
333
|
+
departments?: Lark.UserDepartmentInfo[];
|
|
334
|
+
/** 指定恢复后分配的席位 */
|
|
335
|
+
subscription_ids?: string[];
|
|
336
|
+
}
|
|
337
|
+
interface ResurrectQuery {
|
|
338
|
+
/** 用户id类型 */
|
|
339
|
+
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
340
|
+
/** 部门id类型 */
|
|
341
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
342
|
+
}
|
|
343
|
+
interface ListQuery extends Pagination {
|
|
344
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
345
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
346
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
347
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
348
|
+
/** 填写该字段表示获取部门下所有用户,选填。 */
|
|
349
|
+
department_id?: string;
|
|
350
|
+
}
|
|
351
|
+
const enum UpdateRequestGender {
|
|
352
|
+
/** 保密 */
|
|
353
|
+
Unkown = 0,
|
|
354
|
+
/** 男 */
|
|
355
|
+
Male = 1,
|
|
356
|
+
/** 女 */
|
|
357
|
+
Female = 2,
|
|
358
|
+
/** 其他 */
|
|
359
|
+
Others = 3
|
|
360
|
+
}
|
|
361
|
+
interface UpdateRequest {
|
|
362
|
+
/** 用户名 */
|
|
363
|
+
name: string;
|
|
364
|
+
/** 英文名 */
|
|
365
|
+
en_name?: string;
|
|
366
|
+
/** 别名 */
|
|
367
|
+
nickname?: string;
|
|
368
|
+
/** 邮箱 */
|
|
369
|
+
email?: string;
|
|
370
|
+
/** 手机号 */
|
|
371
|
+
mobile: string;
|
|
372
|
+
/** 手机号码可见性,true 为可见,false 为不可见,目前默认为 true。不可见时,组织员工将无法查看该员工的手机号码 */
|
|
373
|
+
mobile_visible?: boolean;
|
|
374
|
+
/** 性别 */
|
|
375
|
+
gender?: UpdateRequestGender;
|
|
376
|
+
/** 头像的文件Key */
|
|
377
|
+
avatar_key?: string;
|
|
378
|
+
/** 用户所在部门ID */
|
|
379
|
+
department_ids: string[];
|
|
380
|
+
/** 用户直属上级 */
|
|
381
|
+
leader_user_id?: string;
|
|
382
|
+
/** 城市 */
|
|
383
|
+
city?: string;
|
|
384
|
+
/** 国家 */
|
|
385
|
+
country?: string;
|
|
386
|
+
/** 工位 */
|
|
387
|
+
work_station?: string;
|
|
388
|
+
/** 入职时间 */
|
|
389
|
+
join_time?: number;
|
|
390
|
+
/** 工号 */
|
|
391
|
+
employee_no?: string;
|
|
392
|
+
/** 员工类型 */
|
|
393
|
+
employee_type: number;
|
|
394
|
+
/** 用户排序信息 */
|
|
395
|
+
orders?: Lark.UserOrder[];
|
|
396
|
+
/** 自定义属性 */
|
|
397
|
+
custom_attrs?: Lark.UserCustomAttr[];
|
|
398
|
+
/** 企业邮箱 */
|
|
399
|
+
enterprise_email?: string;
|
|
400
|
+
/** 职务 */
|
|
401
|
+
job_title?: string;
|
|
402
|
+
/** 是否冻结用户 */
|
|
403
|
+
is_frozen?: boolean;
|
|
404
|
+
}
|
|
405
|
+
interface UpdateQuery {
|
|
406
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
407
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
408
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
409
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
410
|
+
}
|
|
411
|
+
interface UpdateResponse {
|
|
412
|
+
user?: Lark.User;
|
|
413
|
+
}
|
|
414
|
+
}
|
|
415
|
+
namespace Group {
|
|
416
|
+
interface Methods {
|
|
417
|
+
member: Member.Methods;
|
|
418
|
+
/**
|
|
419
|
+
* 创建用户组
|
|
420
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/create
|
|
421
|
+
*/
|
|
422
|
+
create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
|
|
423
|
+
/**
|
|
424
|
+
* 更新用户组
|
|
425
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/patch
|
|
426
|
+
*/
|
|
427
|
+
patch(group_id: string, body: PatchRequest, query?: PatchQuery): Promise<void>;
|
|
428
|
+
/**
|
|
429
|
+
* 查询指定用户组
|
|
430
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/get
|
|
431
|
+
*/
|
|
432
|
+
get(group_id: string, query?: GetQuery): Promise<GetResponse>;
|
|
433
|
+
/**
|
|
434
|
+
* 查询用户组列表
|
|
435
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/simplelist
|
|
436
|
+
*/
|
|
437
|
+
simplelist(query?: SimplelistQuery): Paginated<Lark.Group, 'grouplist'>;
|
|
438
|
+
/**
|
|
439
|
+
* 查询用户所属用户组
|
|
440
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/member_belong
|
|
441
|
+
*/
|
|
442
|
+
memberBelong(query?: MemberBelongQuery): Paginated<string, 'group_list'>;
|
|
443
|
+
/**
|
|
444
|
+
* 删除用户组
|
|
445
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/delete
|
|
446
|
+
*/
|
|
447
|
+
delete(group_id: string): Promise<void>;
|
|
448
|
+
}
|
|
449
|
+
const enum CreateRequestType {
|
|
450
|
+
/** 普通用户组 */
|
|
451
|
+
Assign = 1,
|
|
452
|
+
/** 动态用户组 */
|
|
453
|
+
Dynamic = 2
|
|
454
|
+
}
|
|
455
|
+
interface CreateRequest {
|
|
456
|
+
/** 用户组的名字,企业内唯一,最大长度:100 字符 */
|
|
457
|
+
name: string;
|
|
458
|
+
/** 用户组描述 */
|
|
459
|
+
description?: string;
|
|
460
|
+
/** 用户组的类型。默认为1表示普通用户组 */
|
|
461
|
+
type?: CreateRequestType;
|
|
462
|
+
/** 自定义用户组ID,可在创建时自定义,不自定义则由系统自动生成,已创建用户组不允许修改 group_id 。自定义group_id数据校验规则:最大长度:64 字符校验规则:数字、大小写字母的组合,不能包含空格 */
|
|
463
|
+
group_id?: string;
|
|
464
|
+
}
|
|
465
|
+
interface CreateQuery {
|
|
466
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
467
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
468
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
469
|
+
department_id_type?: 'open_department_id' | 'department_id';
|
|
470
|
+
}
|
|
471
|
+
interface CreateResponse {
|
|
472
|
+
/** 用户组ID */
|
|
473
|
+
group_id: string;
|
|
474
|
+
}
|
|
475
|
+
interface PatchRequest {
|
|
476
|
+
/** 用户组的名字,企业内唯一,最大长度:100 字符 */
|
|
477
|
+
name?: string;
|
|
478
|
+
/** 用户组描述信息最大长度:500 字 */
|
|
479
|
+
description?: string;
|
|
480
|
+
}
|
|
481
|
+
interface PatchQuery {
|
|
482
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
483
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
484
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
485
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
486
|
+
}
|
|
487
|
+
interface GetQuery {
|
|
488
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
489
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
490
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
491
|
+
department_id_type?: 'open_department_id' | 'department_id';
|
|
492
|
+
}
|
|
493
|
+
interface GetResponse {
|
|
494
|
+
/** 用户组详情 */
|
|
495
|
+
group: Lark.Group;
|
|
496
|
+
}
|
|
497
|
+
const enum SimplelistQueryType {
|
|
498
|
+
/** 普通用户组 */
|
|
499
|
+
Assign = 1,
|
|
500
|
+
/** 动态用户组 */
|
|
501
|
+
Dynamic = 2
|
|
502
|
+
}
|
|
503
|
+
interface SimplelistQuery extends Pagination {
|
|
504
|
+
/** 用户组类型 */
|
|
505
|
+
type?: SimplelistQueryType;
|
|
506
|
+
}
|
|
507
|
+
const enum MemberBelongQueryGroupType {
|
|
508
|
+
/** 普通用户组 */
|
|
509
|
+
Assign = 1,
|
|
510
|
+
/** 动态用户组 */
|
|
511
|
+
Dynamic = 2
|
|
512
|
+
}
|
|
513
|
+
interface MemberBelongQuery extends Pagination {
|
|
514
|
+
/** 成员ID */
|
|
515
|
+
member_id: string;
|
|
516
|
+
/** 成员ID类型 */
|
|
517
|
+
member_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
518
|
+
/** 欲获取的用户组类型 */
|
|
519
|
+
group_type?: MemberBelongQueryGroupType;
|
|
520
|
+
}
|
|
521
|
+
namespace Member {
|
|
522
|
+
interface Methods {
|
|
523
|
+
/**
|
|
524
|
+
* 添加用户组成员
|
|
525
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/add
|
|
526
|
+
*/
|
|
527
|
+
add(group_id: string, body: AddRequest): Promise<void>;
|
|
528
|
+
/**
|
|
529
|
+
* 批量添加用户组成员
|
|
530
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/batch_add
|
|
531
|
+
*/
|
|
532
|
+
batchAdd(group_id: string, body: BatchAddRequest): Promise<BatchAddResponse>;
|
|
533
|
+
/**
|
|
534
|
+
* 查询用户组成员列表
|
|
535
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/simplelist
|
|
536
|
+
*/
|
|
537
|
+
simplelist(group_id: string, query?: SimplelistQuery): Paginated<Lark.Memberlist, 'memberlist'>;
|
|
538
|
+
/**
|
|
539
|
+
* 移除用户组成员
|
|
540
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/remove
|
|
541
|
+
*/
|
|
542
|
+
remove(group_id: string, body: RemoveRequest): Promise<void>;
|
|
543
|
+
/**
|
|
544
|
+
* 批量移除用户组成员
|
|
545
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/batch_remove
|
|
546
|
+
*/
|
|
547
|
+
batchRemove(group_id: string, body: BatchRemoveRequest): Promise<void>;
|
|
548
|
+
}
|
|
549
|
+
interface AddRequest {
|
|
550
|
+
/** 用户组成员的类型,取值为 user */
|
|
551
|
+
member_type: 'user';
|
|
552
|
+
/** 当member_type =user时候,member_id_type表示user_id_type,枚举值为open_id, union_id, user_id */
|
|
553
|
+
member_id_type: 'open_id' | 'union_id' | 'user_id';
|
|
554
|
+
/** 添加的成员ID */
|
|
555
|
+
member_id: string;
|
|
556
|
+
}
|
|
557
|
+
interface BatchAddRequest {
|
|
558
|
+
/** 待添加成员 */
|
|
559
|
+
members?: Lark.Memberlist[];
|
|
560
|
+
}
|
|
561
|
+
interface BatchAddResponse {
|
|
562
|
+
/** 成员添加操作结果 */
|
|
563
|
+
results?: Lark.MemberResult[];
|
|
564
|
+
}
|
|
565
|
+
interface SimplelistQuery extends Pagination {
|
|
566
|
+
/** 欲获取成员ID类型。当member_type=user时候,member_id_type表示user_id_type,枚举值open_id, union_id和user_id。当member_type=department时候,member_id_type表示department_id_type,枚举值open_id和department_id。 */
|
|
567
|
+
member_id_type?: 'open_id' | 'union_id' | 'user_id' | 'department_id';
|
|
568
|
+
/** 欲获取的用户组成员类型。 */
|
|
569
|
+
member_type?: 'user' | 'department';
|
|
570
|
+
}
|
|
571
|
+
interface RemoveRequest {
|
|
572
|
+
/** 用户组成员的类型,取值为 user */
|
|
573
|
+
member_type: 'user';
|
|
574
|
+
/** 操作移除的用户组成员ID */
|
|
575
|
+
member_id: string;
|
|
576
|
+
/** 当member_type =user时候,member_id_type表示user_id_type,枚举值为open_id, union_id, user_id */
|
|
577
|
+
member_id_type: 'open_id' | 'union_id' | 'user_id';
|
|
578
|
+
}
|
|
579
|
+
interface BatchRemoveRequest {
|
|
580
|
+
/** 待移除成员 */
|
|
581
|
+
members: Lark.Memberlist[];
|
|
582
|
+
}
|
|
583
|
+
}
|
|
584
|
+
}
|
|
585
|
+
namespace CustomAttr {
|
|
586
|
+
interface Methods {
|
|
587
|
+
/**
|
|
588
|
+
* 获取企业自定义用户字段
|
|
589
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/custom_attr/list
|
|
590
|
+
*/
|
|
591
|
+
list(query?: Pagination): Paginated<Lark.CustomAttr>;
|
|
592
|
+
}
|
|
593
|
+
}
|
|
594
|
+
namespace EmployeeTypeEnum {
|
|
595
|
+
interface Methods {
|
|
596
|
+
/**
|
|
597
|
+
* 新增人员类型
|
|
598
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/create
|
|
599
|
+
*/
|
|
600
|
+
create(body: CreateRequest): Promise<CreateResponse>;
|
|
601
|
+
/**
|
|
602
|
+
* 更新人员类型
|
|
603
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/update
|
|
604
|
+
*/
|
|
605
|
+
update(enum_id: string, body: UpdateRequest): Promise<UpdateResponse>;
|
|
606
|
+
/**
|
|
607
|
+
* 查询人员类型
|
|
608
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/list
|
|
609
|
+
*/
|
|
610
|
+
list(query?: Pagination): Paginated<Lark.EmployeeTypeEnum>;
|
|
611
|
+
/**
|
|
612
|
+
* 删除人员类型
|
|
613
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/delete
|
|
614
|
+
*/
|
|
615
|
+
delete(enum_id: string): Promise<void>;
|
|
616
|
+
}
|
|
617
|
+
const enum CreateRequestEnumType {
|
|
618
|
+
/** 内置类型 */
|
|
619
|
+
Defualt = 1,
|
|
620
|
+
/** 自定义 */
|
|
621
|
+
Custom = 2
|
|
622
|
+
}
|
|
623
|
+
const enum CreateRequestEnumStatus {
|
|
624
|
+
/** 激活 */
|
|
625
|
+
Active = 1,
|
|
626
|
+
/** 未激活 */
|
|
627
|
+
Inactive = 2
|
|
628
|
+
}
|
|
629
|
+
interface CreateRequest {
|
|
630
|
+
/** 枚举内容 */
|
|
631
|
+
content: string;
|
|
632
|
+
/** 类型 */
|
|
633
|
+
enum_type: CreateRequestEnumType;
|
|
634
|
+
/** 类型 */
|
|
635
|
+
enum_status: CreateRequestEnumStatus;
|
|
636
|
+
/** i18n定义 */
|
|
637
|
+
i18n_content?: Lark.I18nContent[];
|
|
638
|
+
}
|
|
639
|
+
interface CreateResponse {
|
|
640
|
+
/** 创建人员类型接口 */
|
|
641
|
+
employee_type_enum?: Lark.EmployeeTypeEnum;
|
|
642
|
+
}
|
|
643
|
+
const enum UpdateRequestEnumType {
|
|
644
|
+
/** 内置类型 */
|
|
645
|
+
Defualt = 1,
|
|
646
|
+
/** 自定义 */
|
|
647
|
+
Custom = 2
|
|
648
|
+
}
|
|
649
|
+
const enum UpdateRequestEnumStatus {
|
|
650
|
+
/** 激活 */
|
|
651
|
+
Active = 1,
|
|
652
|
+
/** 未激活 */
|
|
653
|
+
Inactive = 2
|
|
654
|
+
}
|
|
655
|
+
interface UpdateRequest {
|
|
656
|
+
/** 枚举内容 */
|
|
657
|
+
content: string;
|
|
658
|
+
/** 类型 */
|
|
659
|
+
enum_type: UpdateRequestEnumType;
|
|
660
|
+
/** 类型 */
|
|
661
|
+
enum_status: UpdateRequestEnumStatus;
|
|
662
|
+
/** i18n定义 */
|
|
663
|
+
i18n_content?: Lark.I18nContent[];
|
|
664
|
+
}
|
|
665
|
+
interface UpdateResponse {
|
|
666
|
+
employee_type_enum?: Lark.EmployeeTypeEnum;
|
|
667
|
+
}
|
|
668
|
+
}
|
|
669
|
+
namespace Department {
|
|
670
|
+
interface Methods {
|
|
671
|
+
/**
|
|
672
|
+
* 创建部门
|
|
673
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/create
|
|
674
|
+
*/
|
|
675
|
+
create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
|
|
676
|
+
/**
|
|
677
|
+
* 修改部门部分信息
|
|
678
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/patch
|
|
679
|
+
*/
|
|
680
|
+
patch(department_id: string, body: PatchRequest, query?: PatchQuery): Promise<PatchResponse>;
|
|
681
|
+
/**
|
|
682
|
+
* 更新部门所有信息
|
|
683
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/update
|
|
684
|
+
*/
|
|
685
|
+
update(department_id: string, body: UpdateRequest, query?: UpdateQuery): Promise<UpdateResponse>;
|
|
686
|
+
/**
|
|
687
|
+
* 更新部门 ID
|
|
688
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/update_department_id
|
|
689
|
+
*/
|
|
690
|
+
updateDepartmentId(department_id: string, body: UpdateDepartmentIdRequest, query?: UpdateDepartmentIdQuery): Promise<void>;
|
|
691
|
+
/**
|
|
692
|
+
* 部门群转为普通群
|
|
693
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/unbind_department_chat
|
|
694
|
+
*/
|
|
695
|
+
unbindDepartmentChat(body: UnbindDepartmentChatRequest, query?: UnbindDepartmentChatQuery): Promise<void>;
|
|
696
|
+
/**
|
|
697
|
+
* 获取单个部门信息
|
|
698
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/get
|
|
699
|
+
*/
|
|
700
|
+
get(department_id: string, query?: GetQuery): Promise<GetResponse>;
|
|
701
|
+
/**
|
|
702
|
+
* 批量获取部门信息
|
|
703
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/batch
|
|
704
|
+
*/
|
|
705
|
+
batch(query?: BatchQuery): Promise<BatchResponse>;
|
|
706
|
+
/**
|
|
707
|
+
* 获取子部门列表
|
|
708
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/children
|
|
709
|
+
*/
|
|
710
|
+
children(department_id: string, query?: ChildrenQuery): Paginated<Lark.Department>;
|
|
711
|
+
/**
|
|
712
|
+
* 获取父部门信息
|
|
713
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/parent
|
|
714
|
+
*/
|
|
715
|
+
parent(query?: ParentQuery): Paginated<Lark.Department>;
|
|
716
|
+
/**
|
|
717
|
+
* 搜索部门
|
|
718
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/search
|
|
719
|
+
*/
|
|
720
|
+
search(body: SearchRequest, query?: SearchQuery): Paginated<Lark.Department>;
|
|
721
|
+
/**
|
|
722
|
+
* 删除部门
|
|
723
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/delete
|
|
724
|
+
*/
|
|
725
|
+
delete(department_id: string, query?: DeleteQuery): Promise<void>;
|
|
726
|
+
/**
|
|
727
|
+
* 获取部门信息列表
|
|
728
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/list
|
|
729
|
+
*/
|
|
730
|
+
list(query?: ListQuery): Paginated<Lark.Department>;
|
|
731
|
+
}
|
|
732
|
+
interface CreateRequest {
|
|
733
|
+
/** 部门名称 */
|
|
734
|
+
name: string;
|
|
735
|
+
/** 国际化的部门名称 */
|
|
736
|
+
i18n_name?: Lark.DepartmentI18nName;
|
|
737
|
+
/** 父部门的ID */
|
|
738
|
+
parent_department_id: string;
|
|
739
|
+
/** 本部门的自定义部门ID */
|
|
740
|
+
department_id?: string;
|
|
741
|
+
/** 部门主管用户ID */
|
|
742
|
+
leader_user_id?: string;
|
|
743
|
+
/** 部门的排序 */
|
|
744
|
+
order?: string;
|
|
745
|
+
/** 是否创建部门群,默认不创建 */
|
|
746
|
+
create_group_chat?: boolean;
|
|
747
|
+
/** 部门负责人 */
|
|
748
|
+
leaders?: Lark.DepartmentLeader[];
|
|
749
|
+
/** 部门群雇员类型限制 */
|
|
750
|
+
group_chat_employee_types?: number[];
|
|
751
|
+
/** 部门HRBP */
|
|
752
|
+
department_hrbps?: string[];
|
|
753
|
+
}
|
|
754
|
+
interface CreateQuery {
|
|
755
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
756
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
757
|
+
/** 此次调用中使用的部门ID的类型不同 ID 的说明参见[部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
|
|
758
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
759
|
+
/** 用于幂等判断是否为同一请求,避免重复创建。字符串类型,自行生成。 */
|
|
760
|
+
client_token?: string;
|
|
761
|
+
}
|
|
762
|
+
interface CreateResponse {
|
|
763
|
+
department?: Lark.Department;
|
|
764
|
+
}
|
|
765
|
+
interface PatchRequest {
|
|
766
|
+
/** 部门名 */
|
|
767
|
+
name?: string;
|
|
768
|
+
/** 国际化的部门名称 */
|
|
769
|
+
i18n_name?: Lark.DepartmentI18nName;
|
|
770
|
+
/** 父部门ID */
|
|
771
|
+
parent_department_id?: string;
|
|
772
|
+
/** leaderID */
|
|
773
|
+
leader_user_id?: string;
|
|
774
|
+
/** 部门的排序 */
|
|
775
|
+
order?: string;
|
|
776
|
+
/** 是否创建部门群,默认不创建 */
|
|
777
|
+
create_group_chat?: boolean;
|
|
778
|
+
/** 部门负责人 */
|
|
779
|
+
leaders?: Lark.DepartmentLeader[];
|
|
780
|
+
/** 部门群雇员类型限制 */
|
|
781
|
+
group_chat_employee_types?: number[];
|
|
782
|
+
/** 部门HRBP */
|
|
783
|
+
department_hrbps?: string[];
|
|
784
|
+
}
|
|
785
|
+
interface PatchQuery {
|
|
786
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
787
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
788
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
789
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
790
|
+
}
|
|
791
|
+
interface PatchResponse {
|
|
792
|
+
department?: Lark.Department;
|
|
793
|
+
}
|
|
794
|
+
interface UpdateRequest {
|
|
795
|
+
/** 部门名称 */
|
|
796
|
+
name: string;
|
|
797
|
+
/** 国际化的部门名称 */
|
|
798
|
+
i18n_name?: Lark.DepartmentI18nName;
|
|
799
|
+
/** 父部门ID */
|
|
800
|
+
parent_department_id: string;
|
|
801
|
+
/** LeaderID */
|
|
802
|
+
leader_user_id?: string;
|
|
803
|
+
/** 部门的排序 */
|
|
804
|
+
order?: string;
|
|
805
|
+
/** 是否创建部门群,默认不创建 */
|
|
806
|
+
create_group_chat?: boolean;
|
|
807
|
+
/** 部门负责人 */
|
|
808
|
+
leaders?: Lark.DepartmentLeader[];
|
|
809
|
+
/** 部门群雇员类型限制 */
|
|
810
|
+
group_chat_employee_types?: number[];
|
|
811
|
+
}
|
|
812
|
+
interface UpdateQuery {
|
|
813
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
814
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
815
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
816
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
817
|
+
}
|
|
818
|
+
interface UpdateResponse {
|
|
819
|
+
department?: Lark.Department;
|
|
820
|
+
}
|
|
821
|
+
interface UpdateDepartmentIdRequest {
|
|
822
|
+
/** 本部门的自定义部门新ID */
|
|
823
|
+
new_department_id: string;
|
|
824
|
+
}
|
|
825
|
+
interface UpdateDepartmentIdQuery {
|
|
826
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
827
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
828
|
+
}
|
|
829
|
+
interface UnbindDepartmentChatRequest {
|
|
830
|
+
/** 部门ID */
|
|
831
|
+
department_id: string;
|
|
832
|
+
}
|
|
833
|
+
interface UnbindDepartmentChatQuery {
|
|
834
|
+
/** 此次调用中使用的部门ID的类型,默认为"open_department_id" */
|
|
835
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
836
|
+
}
|
|
837
|
+
interface GetQuery {
|
|
838
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
839
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
840
|
+
/** 此次调用中使用的部门ID的类型不同 ID 的说明 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
|
|
841
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
842
|
+
}
|
|
843
|
+
interface GetResponse {
|
|
844
|
+
department?: Lark.Department;
|
|
845
|
+
}
|
|
846
|
+
interface BatchQuery {
|
|
847
|
+
/** 查询的部门ID列表,类型需要与department_id_type对应 */
|
|
848
|
+
department_ids: string[];
|
|
849
|
+
/** 说明请求中department_id_list参数所使用的部门ID类型 */
|
|
850
|
+
department_id_type?: 'open_department_id' | 'department_id';
|
|
851
|
+
/** 指定调用结果中包含用户(如部门leader)关联的用户ID类型 */
|
|
852
|
+
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
853
|
+
}
|
|
854
|
+
interface BatchResponse {
|
|
855
|
+
/** 查询到的部门信息,其中异常的部门ID不返回结果。 */
|
|
856
|
+
items?: Lark.Department[];
|
|
857
|
+
}
|
|
858
|
+
interface ChildrenQuery extends Pagination {
|
|
859
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
860
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
861
|
+
/** 此次调用中使用的部门ID的类型不同 ID 的说明与department_id的获取方式参见 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
|
|
862
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
863
|
+
/** 是否递归获取子部门 */
|
|
864
|
+
fetch_child?: boolean;
|
|
865
|
+
}
|
|
866
|
+
interface ParentQuery extends Pagination {
|
|
867
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
868
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
869
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
870
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
871
|
+
/** 部门ID */
|
|
872
|
+
department_id: string;
|
|
873
|
+
}
|
|
874
|
+
interface SearchRequest {
|
|
875
|
+
/** 搜索关键词,匹配字段为部门名称(不支持匹配部门国际化名称) */
|
|
876
|
+
query: string;
|
|
877
|
+
}
|
|
878
|
+
interface SearchQuery extends Pagination {
|
|
879
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
880
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
881
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
882
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
883
|
+
}
|
|
884
|
+
interface DeleteQuery {
|
|
885
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
886
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
887
|
+
}
|
|
888
|
+
interface ListQuery extends Pagination {
|
|
889
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
890
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
891
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
892
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
893
|
+
/** 父部门的ID,填上获取部门下所有子部门,此处填写的 ID 必须是 department_id_type 指定的 ID。 */
|
|
894
|
+
parent_department_id?: string;
|
|
895
|
+
/** 是否递归获取子部门 */
|
|
896
|
+
fetch_child?: boolean;
|
|
897
|
+
}
|
|
898
|
+
}
|
|
899
|
+
namespace Unit {
|
|
900
|
+
interface Methods {
|
|
901
|
+
/**
|
|
902
|
+
* 创建单位
|
|
903
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/create
|
|
904
|
+
*/
|
|
905
|
+
create(body: CreateRequest): Promise<CreateResponse>;
|
|
906
|
+
/**
|
|
907
|
+
* 修改单位信息
|
|
908
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/patch
|
|
909
|
+
*/
|
|
910
|
+
patch(unit_id: string, body: PatchRequest): Promise<void>;
|
|
911
|
+
/**
|
|
912
|
+
* 建立部门与单位的绑定关系
|
|
913
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/bind_department
|
|
914
|
+
*/
|
|
915
|
+
bindDepartment(body: BindDepartmentRequest): Promise<void>;
|
|
916
|
+
/**
|
|
917
|
+
* 解除部门与单位的绑定关系
|
|
918
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/unbind_department
|
|
919
|
+
*/
|
|
920
|
+
unbindDepartment(body: UnbindDepartmentRequest): Promise<void>;
|
|
921
|
+
/**
|
|
922
|
+
* 获取单位绑定的部门列表
|
|
923
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/list_department
|
|
924
|
+
*/
|
|
925
|
+
listDepartment(query?: ListDepartmentQuery): Paginated<Lark.UnitDepartment, 'departmentlist'>;
|
|
926
|
+
/**
|
|
927
|
+
* 获取单位信息
|
|
928
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/get
|
|
929
|
+
*/
|
|
930
|
+
get(unit_id: string): Promise<GetResponse>;
|
|
931
|
+
/**
|
|
932
|
+
* 获取单位列表
|
|
933
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/list
|
|
934
|
+
*/
|
|
935
|
+
list(query?: Pagination): Paginated<Lark.Unit, 'unitlist'>;
|
|
936
|
+
/**
|
|
937
|
+
* 删除单位
|
|
938
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/delete
|
|
939
|
+
*/
|
|
940
|
+
delete(unit_id: string): Promise<void>;
|
|
941
|
+
}
|
|
942
|
+
interface CreateRequest {
|
|
943
|
+
/** 单位自定义ID。不带默认自动生成。1-64字节范围大小,需为数字字母 */
|
|
944
|
+
unit_id?: string;
|
|
945
|
+
/** 单位的名字,长度范围为1-100个字 */
|
|
946
|
+
name: string;
|
|
947
|
+
/** 单位类型,长度范围为1-100个字,创建后不可修改 */
|
|
948
|
+
unit_type: string;
|
|
949
|
+
}
|
|
950
|
+
interface CreateResponse {
|
|
951
|
+
/** 单位的自定义ID */
|
|
952
|
+
unit_id: string;
|
|
953
|
+
}
|
|
954
|
+
interface PatchRequest {
|
|
955
|
+
/** 单位的名字 */
|
|
956
|
+
name?: string;
|
|
957
|
+
}
|
|
958
|
+
interface BindDepartmentRequest {
|
|
959
|
+
/** 单位ID */
|
|
960
|
+
unit_id: string;
|
|
961
|
+
/** 单位关联的部门ID */
|
|
962
|
+
department_id: string;
|
|
963
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
964
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
965
|
+
}
|
|
966
|
+
interface UnbindDepartmentRequest {
|
|
967
|
+
/** 单位ID */
|
|
968
|
+
unit_id: string;
|
|
969
|
+
/** 预解除关联的部门ID */
|
|
970
|
+
department_id: string;
|
|
971
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
972
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
973
|
+
}
|
|
974
|
+
interface ListDepartmentQuery extends Pagination {
|
|
975
|
+
/** 单位ID */
|
|
976
|
+
unit_id: string;
|
|
977
|
+
/** 此次调用中预获取的部门ID的类型 */
|
|
978
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
979
|
+
}
|
|
980
|
+
interface GetResponse {
|
|
981
|
+
/** 单位信息 */
|
|
982
|
+
unit: Lark.Unit;
|
|
983
|
+
}
|
|
984
|
+
}
|
|
985
|
+
namespace FunctionalRole {
|
|
986
|
+
interface Methods {
|
|
987
|
+
member: Member.Methods;
|
|
988
|
+
/**
|
|
989
|
+
* 创建角色
|
|
990
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role/create
|
|
991
|
+
*/
|
|
992
|
+
create(body: CreateRequest): Promise<CreateResponse>;
|
|
993
|
+
/**
|
|
994
|
+
* 修改角色名称
|
|
995
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role/update
|
|
996
|
+
*/
|
|
997
|
+
update(role_id: string, body: UpdateRequest): Promise<void>;
|
|
998
|
+
/**
|
|
999
|
+
* 删除角色
|
|
1000
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role/delete
|
|
1001
|
+
*/
|
|
1002
|
+
delete(role_id: string): Promise<void>;
|
|
1003
|
+
}
|
|
1004
|
+
interface CreateRequest {
|
|
1005
|
+
/** 角色名称,在单租户下唯一 */
|
|
1006
|
+
role_name: string;
|
|
1007
|
+
}
|
|
1008
|
+
interface CreateResponse {
|
|
1009
|
+
/** 角色ID,在单租户下唯一 */
|
|
1010
|
+
role_id: string;
|
|
1011
|
+
}
|
|
1012
|
+
interface UpdateRequest {
|
|
1013
|
+
/** 修改的角色名称,在单租户下唯一 */
|
|
1014
|
+
role_name: string;
|
|
1015
|
+
}
|
|
1016
|
+
namespace Member {
|
|
1017
|
+
interface Methods {
|
|
1018
|
+
/**
|
|
1019
|
+
* 批量添加角色成员
|
|
1020
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/batch_create
|
|
1021
|
+
*/
|
|
1022
|
+
batchCreate(role_id: string, body: BatchCreateRequest, query?: BatchCreateQuery): Promise<BatchCreateResponse>;
|
|
1023
|
+
/**
|
|
1024
|
+
* 批量设置角色成员管理范围
|
|
1025
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/scopes
|
|
1026
|
+
*/
|
|
1027
|
+
scopes(role_id: string, body: ScopesRequest, query?: ScopesQuery): Promise<ScopesResponse>;
|
|
1028
|
+
/**
|
|
1029
|
+
* 查询角色下某个成员的管理范围
|
|
1030
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/get
|
|
1031
|
+
*/
|
|
1032
|
+
get(role_id: string, member_id: string, query?: GetQuery): Promise<GetResponse>;
|
|
1033
|
+
/**
|
|
1034
|
+
* 查询角色下的所有成员信息
|
|
1035
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/list
|
|
1036
|
+
*/
|
|
1037
|
+
list(role_id: string, query?: ListQuery): Paginated<Lark.FunctionalRoleMember, 'members'>;
|
|
1038
|
+
/**
|
|
1039
|
+
* 删除角色下的成员
|
|
1040
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/batch_delete
|
|
1041
|
+
*/
|
|
1042
|
+
batchDelete(role_id: string, body: BatchDeleteRequest, query?: BatchDeleteQuery): Promise<BatchDeleteResponse>;
|
|
1043
|
+
}
|
|
1044
|
+
interface BatchCreateRequest {
|
|
1045
|
+
/** 角色添加的角色成员列表(一批用户的UserID列表) */
|
|
1046
|
+
members: string[];
|
|
1047
|
+
}
|
|
1048
|
+
interface BatchCreateQuery {
|
|
1049
|
+
/** 成员ID类型 */
|
|
1050
|
+
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
1051
|
+
}
|
|
1052
|
+
interface BatchCreateResponse {
|
|
1053
|
+
/** 批量新增角色成员结果集 */
|
|
1054
|
+
results?: Lark.FunctionalRoleMemberResult[];
|
|
1055
|
+
}
|
|
1056
|
+
interface ScopesRequest {
|
|
1057
|
+
/** 角色修改的角色成员列表(一批用户的UserID列表) */
|
|
1058
|
+
members: string[];
|
|
1059
|
+
/** 角色内用户的管理范围 */
|
|
1060
|
+
departments: string[];
|
|
1061
|
+
}
|
|
1062
|
+
interface ScopesQuery {
|
|
1063
|
+
/** 用户 ID 类型 */
|
|
1064
|
+
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
1065
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
1066
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
1067
|
+
}
|
|
1068
|
+
interface ScopesResponse {
|
|
1069
|
+
/** 批量更新角色成员管理范围结果集 */
|
|
1070
|
+
results?: Lark.FunctionalRoleMemberResult[];
|
|
1071
|
+
}
|
|
1072
|
+
interface GetQuery {
|
|
1073
|
+
/** 用户 ID 类型 */
|
|
1074
|
+
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
1075
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
1076
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
1077
|
+
}
|
|
1078
|
+
interface GetResponse {
|
|
1079
|
+
/** 成员的管理范围 */
|
|
1080
|
+
member?: Lark.FunctionalRoleMember;
|
|
1081
|
+
}
|
|
1082
|
+
interface ListQuery extends Pagination {
|
|
1083
|
+
/** 用户 ID 类型 */
|
|
1084
|
+
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
1085
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
1086
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
1087
|
+
}
|
|
1088
|
+
interface BatchDeleteRequest {
|
|
1089
|
+
/** 角色删除的角色成员列表(一批用户的UserID列表) */
|
|
1090
|
+
members?: string[];
|
|
1091
|
+
}
|
|
1092
|
+
interface BatchDeleteQuery {
|
|
1093
|
+
/** 成员ID类型 */
|
|
1094
|
+
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
1095
|
+
}
|
|
1096
|
+
interface BatchDeleteResponse {
|
|
1097
|
+
/** 批量新增角色成员结果集 */
|
|
1098
|
+
result?: Lark.FunctionalRoleMemberResult[];
|
|
1099
|
+
}
|
|
1100
|
+
}
|
|
1101
|
+
}
|
|
1102
|
+
namespace JobLevel {
|
|
1103
|
+
interface Methods {
|
|
1104
|
+
/**
|
|
1105
|
+
* 创建职级
|
|
1106
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/create
|
|
1107
|
+
*/
|
|
1108
|
+
create(body: CreateRequest): Promise<CreateResponse>;
|
|
1109
|
+
/**
|
|
1110
|
+
* 更新职级
|
|
1111
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/update
|
|
1112
|
+
*/
|
|
1113
|
+
update(job_level_id: string, body: UpdateRequest): Promise<UpdateResponse>;
|
|
1114
|
+
/**
|
|
1115
|
+
* 获取单个职级信息
|
|
1116
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/get
|
|
1117
|
+
*/
|
|
1118
|
+
get(job_level_id: string): Promise<GetResponse>;
|
|
1119
|
+
/**
|
|
1120
|
+
* 获取租户职级列表
|
|
1121
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/list
|
|
1122
|
+
*/
|
|
1123
|
+
list(query?: ListQuery): Paginated<Lark.JobLevel>;
|
|
1124
|
+
/**
|
|
1125
|
+
* 删除职级
|
|
1126
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/delete
|
|
1127
|
+
*/
|
|
1128
|
+
delete(job_level_id: string): Promise<void>;
|
|
1129
|
+
}
|
|
1130
|
+
interface CreateRequest {
|
|
1131
|
+
/** 职级名称 */
|
|
1132
|
+
name: string;
|
|
1133
|
+
/** 职级描述 */
|
|
1134
|
+
description?: string;
|
|
1135
|
+
/** 职级的排序,可填入自然数100-100000的数值,系统按照数值大小从小到大排序。不填写该字段时,默认新增排序在当前职级列表中最后位(最大值) */
|
|
1136
|
+
order?: number;
|
|
1137
|
+
/** 是否启用 */
|
|
1138
|
+
status: boolean;
|
|
1139
|
+
/** 多语言名称 */
|
|
1140
|
+
i18n_name?: Lark.I18nContent[];
|
|
1141
|
+
/** 多语言描述 */
|
|
1142
|
+
i18n_description?: Lark.I18nContent[];
|
|
1143
|
+
}
|
|
1144
|
+
interface CreateResponse {
|
|
1145
|
+
/** 职级信息 */
|
|
1146
|
+
job_level?: Lark.JobLevel;
|
|
1147
|
+
}
|
|
1148
|
+
interface UpdateRequest {
|
|
1149
|
+
/** 职级名称 */
|
|
1150
|
+
name?: string;
|
|
1151
|
+
/** 职级描述 */
|
|
1152
|
+
description?: string;
|
|
1153
|
+
/** 职级的排序,可填入自然数100-100000的数值,系统按照数值大小从小到大排序。不填写该字段时,默认新增排序在当前职级列表中最后位(最大值) */
|
|
1154
|
+
order?: number;
|
|
1155
|
+
/** 是否启用 */
|
|
1156
|
+
status?: boolean;
|
|
1157
|
+
/** 多语言名称 */
|
|
1158
|
+
i18n_name?: Lark.I18nContent[];
|
|
1159
|
+
/** 多语言描述 */
|
|
1160
|
+
i18n_description?: Lark.I18nContent[];
|
|
1161
|
+
}
|
|
1162
|
+
interface UpdateResponse {
|
|
1163
|
+
/** 职级信息 */
|
|
1164
|
+
job_level?: Lark.JobLevel;
|
|
1165
|
+
}
|
|
1166
|
+
interface GetResponse {
|
|
1167
|
+
/** 职级信息 */
|
|
1168
|
+
job_level?: Lark.JobLevel;
|
|
1169
|
+
}
|
|
1170
|
+
interface ListQuery extends Pagination {
|
|
1171
|
+
/** 传入该字段时,可查询指定职级名称对应的职级信息。 */
|
|
1172
|
+
name?: string;
|
|
1173
|
+
}
|
|
1174
|
+
}
|
|
1175
|
+
namespace JobFamily {
|
|
1176
|
+
interface Methods {
|
|
1177
|
+
/**
|
|
1178
|
+
* 创建序列
|
|
1179
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/create
|
|
1180
|
+
*/
|
|
1181
|
+
create(body: CreateRequest): Promise<CreateResponse>;
|
|
1182
|
+
/**
|
|
1183
|
+
* 更新序列
|
|
1184
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/update
|
|
1185
|
+
*/
|
|
1186
|
+
update(job_family_id: string, body: UpdateRequest): Promise<UpdateResponse>;
|
|
1187
|
+
/**
|
|
1188
|
+
* 获取单个序列信息
|
|
1189
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/get
|
|
1190
|
+
*/
|
|
1191
|
+
get(job_family_id: string): Promise<GetResponse>;
|
|
1192
|
+
/**
|
|
1193
|
+
* 获取租户序列列表
|
|
1194
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/list
|
|
1195
|
+
*/
|
|
1196
|
+
list(query?: ListQuery): Paginated<Lark.JobFamily>;
|
|
1197
|
+
/**
|
|
1198
|
+
* 删除序列
|
|
1199
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/delete
|
|
1200
|
+
*/
|
|
1201
|
+
delete(job_family_id: string): Promise<void>;
|
|
1202
|
+
}
|
|
1203
|
+
interface CreateRequest {
|
|
1204
|
+
/** 序列名称。1-100字符,支持中、英文及符号 */
|
|
1205
|
+
name: string;
|
|
1206
|
+
/** 序列描述,描述序列详情信息 */
|
|
1207
|
+
description?: string;
|
|
1208
|
+
/** 上级序列ID。需是该租户的序列ID列表中的值,对应唯一的序列名称。 */
|
|
1209
|
+
parent_job_family_id?: string;
|
|
1210
|
+
/** 是否启用 */
|
|
1211
|
+
status: boolean;
|
|
1212
|
+
/** 多语言序列名称 */
|
|
1213
|
+
i18n_name?: Lark.I18nContent[];
|
|
1214
|
+
/** 多语言描述 */
|
|
1215
|
+
i18n_description?: Lark.I18nContent[];
|
|
1216
|
+
}
|
|
1217
|
+
interface CreateResponse {
|
|
1218
|
+
/** 序列信息 */
|
|
1219
|
+
job_family?: Lark.JobFamily;
|
|
1220
|
+
}
|
|
1221
|
+
interface UpdateRequest {
|
|
1222
|
+
/** 序列名称。1-100字符,支持中、英文及符号 */
|
|
1223
|
+
name?: string;
|
|
1224
|
+
/** 序列描述,描述序列详情信息 */
|
|
1225
|
+
description?: string;
|
|
1226
|
+
/** 上级序列ID。需是该租户的序列ID列表中的值,对应唯一的序列名称。 */
|
|
1227
|
+
parent_job_family_id?: string;
|
|
1228
|
+
/** 是否启用 */
|
|
1229
|
+
status?: boolean;
|
|
1230
|
+
/** 多语言序列名称 */
|
|
1231
|
+
i18n_name?: Lark.I18nContent[];
|
|
1232
|
+
/** 多语言描述 */
|
|
1233
|
+
i18n_description?: Lark.I18nContent[];
|
|
1234
|
+
}
|
|
1235
|
+
interface UpdateResponse {
|
|
1236
|
+
/** 更新后的序列信息 */
|
|
1237
|
+
job_family?: Lark.JobFamily;
|
|
1238
|
+
}
|
|
1239
|
+
interface GetResponse {
|
|
1240
|
+
/** 序列信息 */
|
|
1241
|
+
job_family?: Lark.JobFamily;
|
|
1242
|
+
}
|
|
1243
|
+
interface ListQuery extends Pagination {
|
|
1244
|
+
/** 序列名称,传入该字段时,可查询指定序列名称对应的序列信息 */
|
|
1245
|
+
name?: string;
|
|
1246
|
+
}
|
|
1247
|
+
}
|
|
1248
|
+
namespace JobTitle {
|
|
1249
|
+
interface Methods {
|
|
1250
|
+
/**
|
|
1251
|
+
* 获取单个职务信息
|
|
1252
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_title/get
|
|
1253
|
+
*/
|
|
1254
|
+
get(job_title_id: string): Promise<GetResponse>;
|
|
1255
|
+
/**
|
|
1256
|
+
* 获取租户职务列表
|
|
1257
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_title/list
|
|
1258
|
+
*/
|
|
1259
|
+
list(query?: Pagination): Paginated<Lark.JobTitle>;
|
|
1260
|
+
}
|
|
1261
|
+
interface GetResponse {
|
|
1262
|
+
/** 职务信息 */
|
|
1263
|
+
job_title?: Lark.JobTitle;
|
|
1264
|
+
}
|
|
1265
|
+
}
|
|
1266
|
+
namespace WorkCity {
|
|
1267
|
+
interface Methods {
|
|
1268
|
+
/**
|
|
1269
|
+
* 获取单个工作城市信息
|
|
1270
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/work_city/get
|
|
1271
|
+
*/
|
|
1272
|
+
get(work_city_id: string): Promise<GetResponse>;
|
|
1273
|
+
/**
|
|
1274
|
+
* 获取租户工作城市列表
|
|
1275
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/work_city/list
|
|
1276
|
+
*/
|
|
1277
|
+
list(query?: Pagination): Paginated<Lark.WorkCity>;
|
|
1278
|
+
}
|
|
1279
|
+
interface GetResponse {
|
|
1280
|
+
/** 工作城市信息 */
|
|
1281
|
+
work_city?: Lark.WorkCity;
|
|
1282
|
+
}
|
|
1283
|
+
}
|
|
1209
1284
|
}
|